home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xext / XeviQueryVersion.z / XeviQueryVersion
Encoding:
Text File  |  2002-10-03  |  7.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXEEEEVVVVIIII((((3333XXXX11111111))))         XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))          XXXXEEEEVVVVIIII((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XeviQueryExtension, XeviQueryVersion, XeviGetVisualInfo - X
  10.           Extended Visual Information functions
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <X11/extensions/XEVI.h>
  14.  
  15.           Bool XeviQueryExtension (Display *dpy);
  16.  
  17.           Bool XeviQueryVersion (Display *dpy,
  18.               int *major_version_return,
  19.               int *minor_version_return);
  20.  
  21.           int XeviGetVisualInfo (Display *dpy, VisualID *visual,
  22.               int n_visual, ExtendedVisualInfo ** evi_return,
  23.               int * n_info_return);
  24.  
  25.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.           The X11 Extended Visual Information extension (EVI) allows a
  27.           client to determine information about core X visuals beyond
  28.           what the core protocol provides.
  29.  
  30.           The EVI application programming library contains the
  31.           interfaces described below.  With the exception of
  32.           XXXXeeeevvvviiiiQQQQuuuueeeerrrryyyyEEEExxxxtttteeeennnnssssiiiioooonnnn,,,, if any of these routines are called with
  33.           a display that does not support the extension, the
  34.           ExtensionErrorHandler (which can be set with
  35.           XXXXSSSSeeeettttEEEExxxxtttteeeennnnssssiiiioooonnnnEEEErrrrrrrroooorrrrHHHHaaaannnnddddlllleeeerrrr and functions the same way as
  36.           XXXXSSSSeeeettttEEEErrrrrrrroooorrrrHHHHaaaannnnddddlllleeeerrrr) will be called and the function will then
  37.           return.
  38.  
  39.           XXXXeeeevvvviiiiQQQQuuuueeeerrrryyyyEEEExxxxtttteeeennnnssssiiiioooonnnn returns TTTTrrrruuuueeee if the Extended Visual
  40.           Information extension is available on the given display.  A
  41.           client must call XXXXeeeevvvviiiiQQQQuuuueeeerrrryyyyEEEExxxxtttteeeennnnssssiiiioooonnnn before calling any other
  42.           EVI function in order to negotiate a compatible protocol
  43.           version; otherwise the client will get undefined behavior
  44.           (EVI may or may not work).
  45.  
  46.           XXXXeeeevvvviiiiQQQQuuuueeeerrrryyyyVVVVeeeerrrrssssiiiioooonnnn returns TTTTrrrruuuueeee if the request succeeded; the
  47.           values of the major and minor protocol version supported by
  48.           the server are returned in _m_a_j_o_r__v_e_r_s_i_o_n__r_e_t_u_r_n and
  49.           _m_i_n_o_r__v_e_r_s_i_o_n__r_e_t_u_r_n.
  50.  
  51.           XXXXeeeevvvviiiiGGGGeeeettttVVVViiiissssuuuuaaaallllIIIInnnnffffoooo returns a list of ExtendedVisualInfo
  52.           structures that describe visual information beyond that
  53.           supported by the core protocol. This includes layer
  54.           information relevant for systems supporting overlays and/or
  55.           underlay planes, and information that allows applications
  56.           better to determine the level of hardware support for
  57.           multiple colormaps. XeviGetVisualInfo returns SSSSuuuucccccccceeeessssssss if
  58.           successful, or an X error otherwise.  If the argument _v_i_s_u_a_l
  59.           is NULL, then information for all visuals of all screens is
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXEEEEVVVVIIII((((3333XXXX11111111))))         XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))          XXXXEEEEVVVVIIII((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           returned. Otherwise, it's a pointer to a list of visuals for
  75.           which extended visual information is desired.  _n__v_i_s_u_a_l is
  76.           the number of elements in the array visual.  _e_v_i__r_e_t_u_r_n
  77.           returns a pointer to a list of ExtendedVisualInfo. When
  78.           done, the client should free the list using XFree.
  79.           _n__i_n_f_o__r_e_t_u_r_n returns the number of elements in the array
  80.           evi_return.
  81.  
  82.           The EEEExxxxtttteeeennnnddddeeeeddddVVVViiiissssuuuuaaaallllIIIInnnnffffoooo structure has the following fields:
  83.                VisualID        _c_o_r_e__v_i_s_u_a_l__i_d
  84.                int             _s_c_r_e_e_n
  85.                int             _l_e_v_e_l
  86.                unsigned int    _t_r_a_n_s_p_a_r_e_n_c_y__t_y_p_e
  87.                unsigned int    _t_r_a_n_s_p_a_r_e_n_c_y__v_a_l_u_e
  88.                unsigned int    _m_i_n__h_w__c_o_l_o_r_m_a_p_s
  89.                unsigned int    _m_a_x__h_w__c_o_l_o_r_m_a_p_s
  90.                unsigned int    _n_u_m__c_o_l_o_r_m_a_p__c_o_n_f_l_i_c_t_s
  91.                VisualID *      _c_o_l_o_r_m_a_p__c_o_n_f_l_i_c_t_s
  92.  
  93.           The combination of _c_o_r_e__v_i_s_u_a_l__i_d and _s_c_r_e_e_n number uniquely
  94.           specify the visual being described.
  95.  
  96.           _l_e_v_e_l returns the level number for the visual, 0 for normal
  97.           planes, > 0 for overlays, < 0 for underlays.
  98.  
  99.           _t_r_a_n_s_p_a_r_e_n_c_y__t_y_p_e returns the type of transparency supported
  100.           by the visual. XEVI_TRANSPARENCY_NONE if there are no
  101.           transparent pixels, XEVI_TRANSPARENCY_PIXEL if the visual
  102.           supports a transparent pixel, XEVI_TRANSPARENCY_MASK if the
  103.           visual supports transparent plane(s).
  104.  
  105.           _t_r_a_n_s_p_a_r_e_n_c_y__v_a_l_u_e returns the pixel/plane value to set for
  106.           transparency if transparency_type isn't
  107.           XEVI_TRANSPARENCY_NONE.
  108.  
  109.           _m_i_n__h_w__c_o_l_o_r_m_a_p_s and _m_a_x__h_w__c_o_l_o_r_m_a_p_s return the minimum and
  110.           maximum number of hardware colormaps backing up the visual.
  111.  
  112.           _n_u_m__c_o_l_o_r_m_a_p__c_o_n_f_l_i_c_t_s returns the number of elements in
  113.           _c_o_l_o_r_m_a_p__c_o_n_f_l_i_c_t_s. This array returns a list of visuals
  114.           that may cause conflicts in the use of the hardware
  115.           colormap. For example, if a 12-bit hardware colormap is
  116.           overloaded to support 8-bit colormaps, the corresponding 8-
  117.           bit visuals would conflict with the 12-bit visuals.
  118.  
  119.  
  120.      EEEERRRRRRRROOOORRRRSSSS
  121.           XXXXeeeevvvviiiiGGGGeeeettttVVVViiiissssuuuuaaaallllIIIInnnnffffoooo will return _B_a_d_V_a_l_u_e if passed an illegal
  122.           visual ID, _B_a_d_A_c_c_e_s_s if the X server does not respond,
  123.           _B_a_d_A_l_l_o_c if there is a memory allocation failure.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.